Skip to content

Conversation

@lavalleeale
Copy link
Contributor

This adds the documentation for the new environment variables added in Submitty/Submitty#11922

Copy link
Contributor

@jeffrey-cordero jeffrey-cordero left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation for these VM resource configuration variables looks clear and concise.

@github-project-automation github-project-automation bot moved this from Seeking Reviewer to Awaiting Maintainer Review in Submitty Development Jul 29, 2025
bmcutler pushed a commit to Submitty/Submitty that referenced this pull request Jul 29, 2025
### Why is this Change Important & Necessary?
<!-- Include any GitHub issue that is fixed/closed using "Fixes
#<number>" or "Closes #<number>" syntax.
Alternately write "Partially addresses #<number>" or "Related to
#<number>" as appropriate. -->
Currently whenever `vagrant up` is run the VM is created with 2G of ram
and 2 cpus.

### What is the New Behavior?
<!-- Include before & after screenshots/videos if the user interface has
changed. -->
This adds two new environment variables that can be used to configure
the values for the vm. An example of both of them used is
`VM_MEMORY=4096 VM_CPUS=4 vagrant up`

### What steps should a reviewer take to reproduce or test the bug or
new feature?
1. Run `vagrant up` and observe the memory and cpus allocated to your
vm.
2. Run `vagrant halt && vagrant up` with `VM_CPUS` and/or `VM_MEMORY`
set and verify the correct value is used.

### Automated Testing & Documentation
<!-- Is this feature sufficiently tested by unit tests and end-to-end
tests?
If this PR does not add/update the necessary automated tests, write a
new GitHub issue and link it below.
Is this feature sufficiently documented on submitty.org?
Link related PRs or new GitHub issue to update documentation. -->

documentation added in PR:
Submitty/submitty.github.io#695

### Other information
<!-- Is this a breaking change?  
Does this PR include migrations to update existing installations?  
Are there security concerns with this PR? -->
@bmcutler bmcutler merged commit c5e6af9 into main Jul 29, 2025
3 checks passed
@bmcutler bmcutler deleted the vagrant-env-cpu branch July 29, 2025 16:49
@github-project-automation github-project-automation bot moved this from Awaiting Maintainer Review to Done in Submitty Development Jul 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

4 participants